/*
 * Copyright (c) 2025 Huawei Device Co., Ltd.
 * Licensed under the Apache License, Version 2.0 (the "License"),
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/**
 * @addtogroup TeeTrusted
 * @{
 *
 * @brief TEE（Trusted Excution Environment）可信执行环境API。
 *
 * 提供安全能力API，例如可信存储、加解密及可信时间等，用于可信应用程序开发。
 *
 * @since 20
 */

/**
 * @file tee_hw_ext_api_legacy.h
 *
 * @brief 提供扩展接口。
 *
 * @library NA
 * @kit TEEKit
 * @include <TEEKit/tee_hw_ext_api_legacy.h>
 * @syscap SystemCapability.Tee.TeeClient
 * @since 20
 */

#ifndef __TEE_HW_EXT_API_LEGACY_H__
#define __TEE_HW_EXT_API_LEGACY_H__

#include "tee_defines.h"
#include "tee_crypto_api.h"

#ifdef __cplusplus
extern "C" {
#endif

/**
 * @brief 从设备根密钥派生密钥。
 *
 * @param salt [IN]指向盐值数据的指针。
 * @param size [IN]盐值的长度。
 * @param key [OUT]指向保存派生密钥的指针。
 * @param key_size [IN]密钥的大小，必须是16的整数倍。
 *
 * @return TEE_SUCCESS：操作成功。\n
 *         TEE_ERROR_BAD_PARAMETERS：输入参数不正确。\n
 *         TEE_ERROR_GENERIC：处理失败。
 * @since 20
 */
TEE_Result TEE_EXT_DeriveTARootKey(const uint8_t *salt, uint32_t size, uint8_t *key, uint32_t key_size);

/**
 * @brief 通过HUK2从设备根密钥派生密钥。
 * @attention 如果设备不支持HUK2，则使用HUK进行密钥派生。
 *
 * @param secret [IN]指向输入的密钥材料。
 * @param secret_len [IN]输入密钥材料的长度。
 * @param key [OUT]指向派生密钥的指针。
 * @param key_len [IN]派生密钥的长度。
 *
 * @return TEE_SUCCESS：操作成功。\n
 *         TEE_ERROR_BAD_PARAMETERS：输入参数不正确。\n
 *         TEE_ERROR_GENERIC：处理失败。
 * @since 20
 */
TEE_Result tee_ext_root_derive_key2_by_huk2(const uint8_t *secret, uint32_t secret_len, uint8_t *key, uint32_t key_len);

/**
 * @brief 通过HUK2从设备根密钥和当前任务的UUID派生密钥。
 * @attention 如果设备不支持HUK2，则使用HUK进行密钥派生。
 *
 * @param salt [IN]指向盐值数据的指针。
 * @param size [IN]盐值的长度。
 * @param key [OUT]指向保存派生密钥的指针。
 * @param key_size [IN]生成密钥的大小，固定为32字节。
 *
 * @return TEE_SUCCESS：操作成功。\n
 *         TEE_ERROR_BAD_PARAMETERS：输入参数不正确。\n
 *         TEE_ERROR_GENERIC：处理失败。
 * @since 20
 */
TEE_Result tee_ext_root_uuid_derive_key_by_huk2(const uint8_t *salt, uint32_t size, uint8_t *key, uint32_t key_size);

/**
 * @brief 使用增强型HUK2，通过根密钥为Keymaster派生密钥。
 *
 * @param secret [IN]输入的密钥原始数据。
 * @param secret_len [IN]输入数据的长度。
 * @param key [OUT]保存派生密钥的指针。
 * @param key_len [OUT]派生密钥的长度。
 *
 * @return TEE_SUCCESS：操作成功。\n
 *         TEE_ERROR_BAD_PARAMETERS：输入参数不正确。\n
 *         TEE_ERROR_GENERIC：处理失败。
 * @since 20
 */
TEE_Result tee_ext_root_derive_key2_by_huk2_enhance(const uint8_t *secret, uint32_t secret_len, uint8_t *key,
                                                    uint32_t key_len);

/**
 * @brief 使用增强型HUK2，通过设备根密钥和当前任务的UUID派生密钥。
 *
 * @param salt [IN]加盐数据。
 * @param size [IN]盐的长度。
 * @param key [OUT]保存派生密钥的指针。
 * @param key_size [OUT]派生密钥的长度，固定为32字节。
 *
 * @return TEE_SUCCESS：操作成功。\n
 *         TEE_ERROR_BAD_PARAMETERS：输入参数不正确。\n
 *         TEE_ERROR_GENERIC：处理失败。
 * @since 20
 */
TEE_Result tee_ext_root_uuid_derive_key_by_huk2_enhance(const uint8_t *salt, uint32_t size, uint8_t *key,
                                                        uint32_t *key_size);

#ifdef __cplusplus
}
#endif

#endif
/** @} */